Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Room - Create room whisper reappears when interacting with it after workspace is deleted. #50692

Merged
merged 31 commits into from
Nov 20, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Oct 13, 2024

Explanation of Change

  • Whisper to create a room in a workspace chat is not removed when workspace is deleted and performing action on the whisper doesn't do anything.
  • This PR updates shouldReportActionBeVisible to also include canUserPerformWriteAction check for the whisper actions.

Fixed Issues

$ #49940
PROPOSAL: #49940 (comment)

Tests

  1. Go to staging.new.expensify.com
  2. Go to workspace chat
  3. Send a mention of a non-existing room
  4. Delete the workspace
  5. Go to workspace chat
  6. Verify whisper is removed
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to staging.new.expensify.com
  2. Go to workspace chat
  3. Send a mention of a non-existing room
  4. Delete the workspace
  5. Go to workspace chat
  6. Verify whisper is removed

QA Steps

  1. Go to staging.new.expensify.com
  2. Go to workspace chat
  3. Send a mention of a non-existing room
  4. Delete the workspace
  5. Go to workspace chat
  6. Verify whisper is removed

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

@Krishna2323 Krishna2323 requested a review from a team as a code owner October 13, 2024 11:07
@melvin-bot melvin-bot bot requested review from rayane-djouah and removed request for a team October 13, 2024 11:07
Copy link

melvin-bot bot commented Oct 13, 2024

@rayane-djouah Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
@@ -28,6 +28,7 @@ import * as PersonalDetailsUtils from './PersonalDetailsUtils';
import * as PolicyUtils from './PolicyUtils';
import * as ReportConnection from './ReportConnection';
import type {OptimisticIOUReportAction, PartialReportAction} from './ReportUtils';
import {canUserPerformWriteAction, getReport} from './ReportUtils';
import StringUtils from './StringUtils';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rayane-djouah, I'm not sure how to fix this warning :(, please let me know if you have some any idea how to fix this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Krishna2323 Let's call canUserPerformWriteAction function in components instead of in the shouldReportActionBeVisible utility function and then pass a boolean to shouldReportActionBeVisible

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rayane-djouah, I found using reportID cleaner instead of using canUserPerformWriteAction in components and then passing it to shouldReportActionBeVisible but let me know if you still think the other way. I will make those changes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't use functions from ReportUtils in ReportActionsUtils because ReportUtils depends on functions from ReportActionsUtils, which would create a circular dependency.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rayane-djouah, should we create the same functions in ReportActionsUtils?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would result in code duplication. According to the author and reviewer checklist:

I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)

Therefore, we should avoid duplicating functions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's call canUserPerformWriteAction function in components instead of in the shouldReportActionBeVisible utility function and then pass a boolean to shouldReportActionBeVisible

@rayane-djouah, then we can do this but then we have to get the report using getReport function in every file which only have the reportID and then we can use canUserPerformWriteAction and pass the result to shouldReportActionBeVisible. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using getReport function (or useOnyx hook) sounds good to me 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for delay, will provide updates within 24hours.

@rayane-djouah
Copy link
Contributor

@Krishna2323 Could you please share an update? Thanks!

) {
return false;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rayane-djouah, if we pass canUserPerformWriteAction boolean to shouldReportActionBeVisible then how we will get the reportID for isActionableJoinRequestPending, should we pass both?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Krishna2323 Can we use reportAction?.reportID instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rayane-djouah, reportAction?.reportID is undefined.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Krishna2323 Then I think we need to pass both

@rayane-djouah
Copy link
Contributor

@Krishna2323 Let's pass both parameters. We also have conflicts.

@rayane-djouah
Copy link
Contributor

@Krishna2323 Friendly bump

@Krishna2323
Copy link
Contributor Author

Sorry for delay, I will provide updates today.

@rayane-djouah
Copy link
Contributor

@Krishna2323 Performance Tests are failing

@@ -635,7 +635,11 @@ const supportedActionTypes: ReportActionName[] = [...Object.values(otherActionTy
* Checks if a reportAction is fit for display, meaning that it's not deprecated, is of a valid
* and supported type, it's not deleted and also not closed.
*/
function shouldReportActionBeVisible(reportAction: OnyxEntry<ReportAction>, key: string | number): boolean {
function shouldReportActionBeVisible(reportAction: OnyxEntry<ReportAction>, key: string | number, reportID: string, canUserPerformWriteAction?: boolean): boolean {
if ((isActionableReportMentionWhisper(reportAction) || isActionableJoinRequestPending(reportID ?? '-1') || isActionableMentionWhisper(reportAction)) && !canUserPerformWriteAction) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewing the code here:

/**
* Checks if a given report action corresponds to a join request action.
* @param reportAction
*/
function isActionableJoinRequest(reportAction: OnyxEntry<ReportAction>): reportAction is ReportAction<typeof CONST.REPORT.ACTIONS.TYPE.ACTIONABLE_JOIN_REQUEST> {
return isActionOfType(reportAction, CONST.REPORT.ACTIONS.TYPE.ACTIONABLE_JOIN_REQUEST);
}
function getActionableJoinRequestPendingReportAction(reportID: string): OnyxEntry<ReportAction> {
const findPendingRequest = Object.values(getAllReportActions(reportID)).find(
(reportActionItem) => isActionableJoinRequest(reportActionItem) && getOriginalMessage(reportActionItem)?.choice === ('' as JoinWorkspaceResolution),
);
return findPendingRequest;
}
/**
* Checks if any report actions correspond to a join request action that is still pending.
* @param reportID
*/
function isActionableJoinRequestPending(reportID: string): boolean {
return !!getActionableJoinRequestPendingReportAction(reportID);
}

I suggest we create a function named isActionableJoinRequestPendingReportAction and refactor the code accordingly:

function isActionableJoinRequestPendingReportAction(reportAction: OnyxEntry<ReportAction>): boolean {
    return isActionableJoinRequest(reportAction) && getOriginalMessage(reportAction)?.choice === ('' as JoinWorkspaceResolution);
}

function getActionableJoinRequestPendingReportAction(reportID: string): OnyxEntry<ReportAction> {
    const findPendingRequest = Object.values(getAllReportActions(reportID)).find((reportActionItem) => isActionableJoinRequestPendingReportAction(reportActionItem));

    return findPendingRequest;
}

Then use isActionableJoinRequestPendingReportAction in the following manner:

Suggested change
if ((isActionableReportMentionWhisper(reportAction) || isActionableJoinRequestPending(reportID ?? '-1') || isActionableMentionWhisper(reportAction)) && !canUserPerformWriteAction) {
if ((isActionableReportMentionWhisper(reportAction) || isActionableJoinRequestPendingReportAction(reportAction) || isActionableMentionWhisper(reportAction)) && !canUserPerformWriteAction) {

This refactor eliminates the need for the reportID parameter.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

Comment on lines 643 to 645
if (!reportAction) {
return false;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this if block first

) {
const targetNote = privateNotes?.[Number(accountID)]?.note ?? '';
const attachments: Attachment[] = [];
const report = ReportUtils.getReport(reportID);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const report = ReportUtils.getReport(reportID);
const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extractAttachments is a util function so we can't use useOnyx here.

Comment on lines 143 to 144

const sortedReportActions = ReportActionsUtils.getSortedReportActionsForDisplay(itemReportActions, reportID, ReportUtils.canUserPerformWriteAction(itemFullReport));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const sortedReportActions = ReportActionsUtils.getSortedReportActionsForDisplay(itemReportActions, reportID, ReportUtils.canUserPerformWriteAction(itemFullReport));
const canUserPerformWriteAction = ReportUtils.canUserPerformWriteAction(itemFullReport);
const sortedReportActions = ReportActionsUtils.getSortedReportActionsForDisplay(itemReportActions, reportID, canUserPerformWriteAction);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

@@ -29,6 +30,8 @@ function ParentNavigationSubtitle({parentNavigationSubtitleData, parentReportAct
const {workspaceName, reportName} = parentNavigationSubtitleData;
const {isOffline} = useNetwork();
const {translate} = useLocalize();
const report = ReportUtils.getReport(parentReportID);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const report = ReportUtils.getReport(parentReportID);
const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

@@ -11,10 +12,12 @@ function usePaginatedReportActions(reportID?: string, reportActionID?: string) {
// Use `||` instead of `??` to handle empty string.
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
const reportIDWithDefault = reportID || '-1';
const report = ReportUtils.getReport(reportIDWithDefault);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const report = ReportUtils.getReport(reportIDWithDefault);
const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

usePaginatedReportActions is a util function so we can't use useOnyx here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useOnyx is already a part of this file, so I assume it works just fine? Generally, ReportUtils.getReport() should be avoided because anything that it returns won't get updated if the onyx data updates.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry my mistake, now updated.

@@ -21,9 +22,11 @@ type DebugReportActionsProps = {
function DebugReportActions({reportID}: DebugReportActionsProps) {
const {translate, datetimeToCalendarTime} = useLocalize();
const styles = useThemeStyles();
const report = ReportUtils.getReport(reportID);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const report = ReportUtils.getReport(reportID);
const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

@Krishna2323
Copy link
Contributor Author

I will work on the suggested changes today.

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Nov 12, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Screen.Recording.2024-11-13.at.5.21.14.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-11-13.at.5.23.59.PM.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-13.at.17.16.28.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-13.at.17.19.37.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-11-13.at.5.04.57.PM.mov
MacOS: Desktop
Screen.Recording.2024-11-13.at.5.08.43.PM.mov

Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and tests well 👍

@melvin-bot melvin-bot bot requested a review from tgolen November 13, 2024 16:28
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there already a unit test explicitly for what is being fixed here? If not, please add one.

@@ -11,10 +12,12 @@ function usePaginatedReportActions(reportID?: string, reportActionID?: string) {
// Use `||` instead of `??` to handle empty string.
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
const reportIDWithDefault = reportID || '-1';
const report = ReportUtils.getReport(reportIDWithDefault);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useOnyx is already a part of this file, so I assume it works just fine? Generally, ReportUtils.getReport() should be avoided because anything that it returns won't get updated if the onyx data updates.

Signed-off-by: krishna2323 <[email protected]>
@rayane-djouah
Copy link
Contributor

Is there already a unit test explicitly for what is being fixed here? If not, please add one.

@Krishna2323 Let's add a test case (for actionable whispers in archived reports) in tests/unit/ReportActionsUtilsTest.ts for ReportActionsUtils.getSortedReportActionsForDisplay similar to these test cases :

it('should filter out closed actions', () => {

it('should filter out non-whitelisted actions', () => {

it('should filter out deleted, non-pending comments', () => {

@Krishna2323
Copy link
Contributor Author

@rayane-djouah test case added for for actionable whispers in archived reports.

input.pop();
expect(result).toStrictEqual(input);
});

it('should filter whisper action in a archived report', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please follow the directions here for adding good comments to the tests?

https://github.com/Expensify/App/blob/e5baec5f9f91821f464bf6c1ff5523482504194d/tests/README.md#documenting-tests

input.pop();
expect(result).toStrictEqual(input);
});

it('should filter whisper action in a archived report', () => {
const input: ReportAction[] = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is all this data necessary for the test?

Copy link
Contributor Author

@Krishna2323 Krishna2323 Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tgolen, yes, it's necessary for checking that other types of actions aren't being filtered.

edit: I have updated the input data according to the test.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I can see how it would be helpful to have some non-actionable whisper action types, but I don't think it's necessary to have all of CREATED, ADD_COMMENT, and CLOSED. I would suggest only having one of them (maybe ADD_COMMENT since that is pretty typical).

If you feel that CREATED and CLOSED is necessary to include, please explain it better why they are necessary as maybe I don't fully understand it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CREATED and CLOSED type actions aren't necessary, removed them from the input and only kept ADD_COMMENT.


const result = ReportActionsUtils.getSortedReportActionsForDisplay(input, false);
// Expected output should filter out actionable whisper actions type e.g. "join", "create room"
// because "canUserPerformWriteAction" is false (report is archived)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rayane-djouah @tgolen, are these comments enough for the explanation? Sorry for the trouble, I'm writing unit tests for the first time :(

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries! You'll get there. A few things:

These comments don't match the instructions I had you look at (it's OK, these are new instructions that we're trying for the first time, so you're also helping me improve the instructions!)

Can you please:

  • Add three separate comments, each for the "Given", "When", and "Then" sections
  • Have each comment explain WHY the code is there like it is
  • Look at other tests in the code using this format to get some ideas (search for // Given). They won't always be the best examples, but you'll get a better idea of what I'm asking for

I'll add some suggestions to your tests here to explain what I mean

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the help 🙏🏻. I now have a better understanding of how the "Given," "When," and "Then" sections should be written. I’ve updated the comments (mostly copied from your suggestions 🫠).


const result = ReportActionsUtils.getSortedReportActionsForDisplay(input, false);
// Expected output should filter out actionable whisper actions type e.g. "join", "create room"
// because "canUserPerformWriteAction" is false (report is archived)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries! You'll get there. A few things:

These comments don't match the instructions I had you look at (it's OK, these are new instructions that we're trying for the first time, so you're also helping me improve the instructions!)

Can you please:

  • Add three separate comments, each for the "Given", "When", and "Then" sections
  • Have each comment explain WHY the code is there like it is
  • Look at other tests in the code using this format to get some ideas (search for // Given). They won't always be the best examples, but you'll get a better idea of what I'm asking for

I'll add some suggestions to your tests here to explain what I mean

input.pop();
expect(result).toStrictEqual(input);
});

it('should filter actionable whisper actions e.g. "join", "create room" when room is archived', () => {
const input: ReportAction[] = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const input: ReportAction[] = [
// Given several different action types, including actionable whispers for creating and joining rooms, as well as non-actionable whispers
// - CREATED
// - ADD_COMMENT
// - ACTIONABLE_REPORT_MENTION_WHISPER
// - ACTIONABLE_MENTION_WHISPER
// - CLOSED
const input: ReportAction[] = [

tests/unit/ReportActionsUtilsTest.ts Show resolved Hide resolved
Comment on lines 568 to 569
// Expected output should filter out actionable whisper actions type e.g. "join", "create room"
// because "canUserPerformWriteAction" is false (report is archived)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Expected output should filter out actionable whisper actions type e.g. "join", "create room"
// because "canUserPerformWriteAction" is false (report is archived)
// Then the output should correctly filter out the actionable whisper types for "join" and "create room"
// because the report is archived and making those actions not only doesn't make sense from a UX standpoint, but leads to server errors since those actions aren't possible.

// Expected output should filter out actionable whisper actions type e.g. "join", "create room"
// because "canUserPerformWriteAction" is false (report is archived)
// eslint-disable-next-line rulesdir/prefer-at
const expectedOutput: ReportAction[] = [...input.slice(1, 3), input[0]];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...input.slice(1, 3), input[0]]; is not very clear that it's specifically filtering out the actionable whispers. I suggest modifying this to use .filter() and filter based on the actionName.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to use filter() method.

input.pop();
expect(result).toStrictEqual(input);
});

it('should filter whisper action in a archived report', () => {
const input: ReportAction[] = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I can see how it would be helpful to have some non-actionable whisper action types, but I don't think it's necessary to have all of CREATED, ADD_COMMENT, and CLOSED. I would suggest only having one of them (maybe ADD_COMMENT since that is pretty typical).

If you feel that CREATED and CLOSED is necessary to include, please explain it better why they are necessary as maybe I don't fully understand it.

Signed-off-by: krishna2323 <[email protected]>
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks really good now! Nice work. I just noticed this one last thing.

tests/unit/ReportActionsUtilsTest.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good! Thank you!

@tgolen tgolen merged commit 1b1e8b4 into Expensify:main Nov 20, 2024
17 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.65-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 success ✅

Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.65-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

),
[sortedReportActions, isOffline],
[sortedReportActions, isOffline, report],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having the report here was retriggering the memo block multiple times, which caused this blocker #52891

@@ -11,10 +12,12 @@ function usePaginatedReportActions(reportID?: string, reportActionID?: string) {
// Use `||` instead of `??` to handle empty string.
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
const reportIDWithDefault = reportID || '-1';
const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, we need to use reportIDWithDefault here. This caused this issue: #52864

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants